# [三] Spring 初始化机制
Spring 容器的初始化流程初探
Spring容器初始化的核心方法refresh()
,下面主要分析obtainFreshBeanFactory()
方法流程,也就是BeanFactory
的创建过程的主要流程。
Spring 容器的加载方式有四种,下面以第一种类路径获取配置文件(ClassPathXmlApplicationContext)
的方式,来看看Spring 容器初始化过程是如何创建BeanFactory
的。
# Spring 初始化核心流程
spring容器初始化的核心方法AbstractApplicationContext#refresh ,
├─
refresh Spring 初始化核心流程入口│ ├─
prepareRefresh ① 准备此上下文用于刷新,设置启动时间和active标志,初始化属性│ ├─
obtainFreshBeanFactory ② 本节主要跟踪的源码流程│ ├─
prepareBeanFactory ③ 设置beanFactory的基本属性│ ├─
postProcessBeanFactory ④ 子类处理自定义的BeanFactoryPostProcess│ ├─
invokeBeanFactoryPostProcessors ⑤ 调用所有的BeanFactoryPostProcessor│ ├─
registerBeanPostProcessors ⑥ 注册,把实现了BeanPostProcessor接口的类实例化,加到BeanFactory│ ├─
initMessageSource ⑦ 初始化上下文中的资源文件,如国际化文件的处理等│ ├─
initApplicationEventMulticaster ⑧ 初始化上下文的事件传播器│ ├─
onRefresh ⑨ 给子类扩展初始化其他Bean,springboot 中用来做内嵌 tomcat 启动│ ├─
registerListeners ⑩ 在所有bean中查找监听 bean,然后注册到广播器中│ ├─
finishBeanFactoryInitialization ⑪ 初始化所有的单例Bean、ioc、BeanPostProcessor的执行、Aop入口│ └─
finishRefresh ⑫ 完成刷新过程,发布相应的事件
以下源码流程是基于 obtainFreshBeanFactory 方法内的执行流程,主要包括: 创建填充BeanFactory xml标签的解析 填充到BeanDefinition,并注入到Spring IOC 容器
# ├─ testSpringLoad()
编写测试类
@Test
public void testSpringLoad() {
ApplicationContext applicationContext = new ClassPathXmlApplicationContext("spring.xml");
}
# ├─ ClassPathXmlApplicationContext()
调用 ClassPathXmlApplicationContext 构造方法,实例化ClassPathXmlApplicationContext上下文
类文件:org.springframework.context.support.
ClassPathXmlApplicationContext
public ClassPathXmlApplicationContext(String configLocation) throws BeansException {
this(new String[] {configLocation}, true, null);
}
实际调用了ClassPathXmlApplicationContext()的重载方法
类文件:org.springframework.context.support.
ClassPathXmlApplicationContext
/**
* TODO : ClassPathXmlApplicationContext的重载方法
*/
public ClassPathXmlApplicationContext(
String[] configLocations, boolean refresh, @Nullable ApplicationContext parent)
throws BeansException {
//实例化的时候,调用父类的构造函数
super(parent);
//创建解析器,解析configLocations
setConfigLocations(configLocations);
if (refresh) {
//Spring容器初始化的核心方法
refresh();
}
}
# ├─ setConfigLocations()
进入 setConfigLocations() 方法
类文件:org.springframework.context.support.
AbstractRefreshableConfigApplicationContext
/**
* TODO : 设置配置文件地址
* 参数locations 就是传递过来的字符串"Spring.xml"
*/
public void setConfigLocations(@Nullable String... locations) {
if (locations != null) {
Assert.noNullElements(locations, "Config locations must not be null");
this.configLocations = new String[locations.length];
for (int i = 0; i < locations.length; i++) {
//模糊匹配,不需要读
this.configLocations[i] = resolvePath(locations[i]).trim();
}
}
else {
this.configLocations = null;
}
}
模糊匹配
此处的模糊匹配,含有多种包含路径场景:
- 比如:
/config/**/Spring.xml
- 比如:
/config/{dev}-Spring.xml
等等,只是进行过滤解析。
# ├─ refresh()
进入 refresh() 方法
类文件:org.springframework.context.support.
AbstractApplicationContext
/*
* TODO : 该方法是spring容器初始化的核心方法,是spring容器初始化的核心流程,
* 是一个典型的父类模板设计模式的运用,根据不同的上下文对象,会掉到不同的上下文
* 对象子类方法中。
*
* 核心上下文子类有:
* ClassPathXmlApplicationContext
* FileSystemXmlApplicationContext
* AnnotationConfigApplicationContext
* EmbeddedWebApplicationContext(springboot)
*
* 方法重要程度:
* 0:不重要,可以不看
* 1:一般重要,可看可不看
* 5:非常重要,一定要看
*
*
* 必须读的 :重要程度 5
* */
@Override
public void refresh() throws BeansException, IllegalStateException {
/**
* TODO :使用对象锁startUpShutdownMonitor进行同步控制:
* 1、避免了多线程同时刷新spring配置,只对不能并发的代码块进行加锁,
* 提高了整体代码运行的效率;
* 2、refresh()方法和 close()方法都使用了startUpShutdownMonitor对象锁加锁,
* 这就保证了在调用refresh()方法的时候无法调用close()方法,避免了冲突;
**/
synchronized (this.startupShutdownMonitor) {
/**
* TODO : 准备此上下文用于刷新
* 1、设置其启动日期和active标志
* 2、执行属性源的初始化。
*/
prepareRefresh();
/**
* TODO : 创建填充BeanFactory功能,以及创建填充XmlBeanDefinitionReader对象
* 重要程度:5
* 1、创建BeanFactory对象
* 2、xml解析
* 传统标签解析:bean、import等
* 自定义标签解析 如:<context:component-scan base-package="com.XXX.XXX"/>
* 自定义标签解析流程:
* a、根据当前解析标签的头信息找到对应的 namespaceUri
* b、加载 spring 所有jar中的 spring.handlers 文件,并建立映射关系
* c、根据 namespaceUri 从映射关系中找到对应的实现了 NamespaceHandler 接口的类
* d、调用类的 init 方法, init 方法是注册了各种自定义标签的解析类
* e、根据 namespaceUri 找到对应的解析类,然后调用 paser 方法完成标签解析
*
* 3、把解析出来的xml标签封装成 BeanDefinition 对象
* */
// Tell the subclass to refresh the internal bean factory.
ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();
// Prepare the bean factory for use in this context.
/*
* 给beanFactory设置一些属性值,可以不看
* */
prepareBeanFactory(beanFactory);
try {
// Allows post-processing of the bean factory in context subclasses.
// 提供子类覆盖的额外处理,即子类处理自定义的BeanFactoryPostProcess
// (如果有某个bean实现了BeanFactoryPostProcessor接口,那么在容器初始化以后,
// Spring会自动调用里面的postProcessBeanFactory方法)
postProcessBeanFactory(beanFactory);
/*
* BeanDefinitionRegistryPostProcessor
* BeanFactoryPostProcessor
* 完成对这两个接口的调用
* */
// Invoke factory processors registered as beans in the context.
// 激活各种 BeanFactory 处理器,并调用 BeanFactoryPostProcessor 各个实现类
// 的 postProcessBeanFactory(factory) 方法
invokeBeanFactoryPostProcessors(beanFactory);
/*
* 把实现了BeanPostProcessor接口的类实例化,并且加入到BeanFactory中
* */
// Register bean processors that intercept bean creation.
// 注册拦截 Bean创建的 Bean处理器,即注册 BeanPostProcessor
registerBeanPostProcessors(beanFactory);
// Initialize message source for this context.
// 初始化上下文中的资源文件,如国际化文件的处理等
initMessageSource();
// Initialize event multicaster for this context.
// 初始化上下文事件广播器(事件广播和监听机制是典型的观察者模式的实现)
initApplicationEventMulticaster();
// 这个方法着重理解模板设计模式,因为在 springboot 中,这个方法是用来做内嵌 tomcat 启动的
// Initialize other special beans in specific context subclasses.
// 给子类扩展初始化其他Bean
onRefresh();
/*
* 往事件管理类中注册事件类
* */
// Check for listener beans and register them.
// 在所有bean中查找listener bean,然后注册到广播器中
registerListeners();
/*
* 这个方法是spring中最重要的方法,没有之一
* 所以这个方法一定要理解要具体看
* TODO : 初始化所有的单例Bean(非延迟加载的)
* 1、bean实例化过程
* 2、ioc
* 3、注解支持
* 4、BeanPostProcessor的执行
* 5、Aop的入口
*
* */
// Instantiate all remaining (non-lazy-init) singletons.
finishBeanFactoryInitialization(beanFactory);
// Last step: publish corresponding event.
// 完成刷新过程,通知生命周期处理器 lifecycleProcessor 刷新过程,同时发出
// ContextRefreshEvent 通知别人
finishRefresh();
}
catch (BeansException ex) {
if (logger.isWarnEnabled()) {
logger.warn("Exception encountered during context initialization - " +
"cancelling refresh attempt: " + ex);
}
// Destroy already created singletons to avoid dangling resources.
// 销毁已经创建的Bean
destroyBeans();
// Reset 'active' flag.
// 重置容器激活标签
cancelRefresh(ex);
// Propagate exception to caller.
throw ex;
}
finally {
// Reset common introspection caches in Spring's core, since we
// might not ever need metadata for singleton beans anymore...
// 当我们可能再也不需要单例 bean的元数据时候,重置 Spring 核心的普通内省缓存
resetCommonCaches();
}
}
}
# ├─ obtainFreshBeanFactory()
进入 obtainFreshBeanFactory()方法
类文件:org.springframework.context.support.
AbstractApplicationContext
/**
* TODO : 获取bean工厂入口
*/
protected ConfigurableListableBeanFactory obtainFreshBeanFactory() {
// 核心方法,必须读,重要程度:5
// 模板涉及模式,子类实现钩子方法。
refreshBeanFactory();
return getBeanFactory();
}
# │ ├─ refreshBeanFactory()
进入子类的 refreshBeanFactory()方法
类文件:org.springframework.context.support.
AbstractRefreshableApplicationContext
/**
* TODO : 创建 bean 工厂
*/
protected final void refreshBeanFactory() throws BeansException {
//如果BeanFactory不为空,则清除BeanFactory和里面的实例
if (hasBeanFactory()) {
destroyBeans();
closeBeanFactory();
}
try {
// 创建DefaultListableBeanFactory(可以创建多个bean实例)
// 和BeanFactory的区别:
// BeanFactory :只能创建单个对象 bean实例
// DefaultListableBeanFactory:可以创建多个 bean实例
DefaultListableBeanFactory beanFactory = createBeanFactory();
// 设置 beanFactory的唯一标识
beanFactory.setSerializationId(getId());
// 设置是否可以循环依赖 allowCircularReferences,默认允许。
// 是否允许使用相同名称重新注册不同的bean实现.
customizeBeanFactory(beanFactory);
// 解析xml,并把xml中的标签封装成BeanDefinition对象
loadBeanDefinitions(beanFactory);
synchronized (this.beanFactoryMonitor) {
this.beanFactory = beanFactory;
}
}
catch (IOException ex) {
throw new ApplicationContextException("I/O error parsing bean definition source for " + getDisplayName(), ex);
}
}
知识点
customizeBeanFactory(beanFactory)中关于设置是否循环依赖
和是否可以覆盖bean定义名称
,可以通过applicationContext上下文来修改,修改后必须要refresh()
重新加载。建议不修改,没有意义。
- applicationContext.setAllowBeanDefinitionOverriding(false);
- applicationContext.setAllowCircularReferences(true);
- applicationContext.refresh();
# │ ├─ loadBeanDefinitions()
进入 loadBeanDefinitions()方法
类文件:org.springframework.context.support.
AbstractXmlApplicationContext
/**
* TODO : 专门用来负责解析XML
*/
protected void loadBeanDefinitions(DefaultListableBeanFactory beanFactory) throws BeansException, IOException {
// Create a new XmlBeanDefinitionReader for the given BeanFactory.
//创建xml的解析器,这里是一个委托模式
XmlBeanDefinitionReader beanDefinitionReader = new XmlBeanDefinitionReader(beanFactory);
// Configure the bean definition reader with this context's
// resource loading environment.
beanDefinitionReader.setEnvironment(this.getEnvironment());
//这里传一个this进去,因为ApplicationContext是实现了ResourceLoader接口的
beanDefinitionReader.setResourceLoader(this);
beanDefinitionReader.setEntityResolver(new ResourceEntityResolver(this));
// Allow a subclass to provide custom initialization of the reader,
// then proceed with actually loading the bean definitions.
initBeanDefinitionReader(beanDefinitionReader);
//主要看这个方法 重要程度 5
loadBeanDefinitions(beanDefinitionReader);
}
进入 loadBeanDefinitions()的重载方法
类文件:org.springframework.context.support.
AbstractXmlApplicationContext
/**
* TODO : 委托给XmlBeanDefinitionReader来进行解析
*/
protected void loadBeanDefinitions(XmlBeanDefinitionReader reader) throws BeansException, IOException {
Resource[] configResources = getConfigResources();
if (configResources != null) {
reader.loadBeanDefinitions(configResources);
}
//获取需要加载的xml配置文件
String[] configLocations = getConfigLocations();
if (configLocations != null) {
// 委托给XmlBeanDefinitionReader来进行解析
reader.loadBeanDefinitions(configLocations);
}
}
进入 loadBeanDefinitions()的重载方法
类文件:org.springframework.context.support.
AbstractBeanDefinitionReader
/**
* TODO : 加载字符串到BeanDefinitions中,即'spring.xml'
*/
public int loadBeanDefinitions(String... locations) throws BeanDefinitionStoreException {
Assert.notNull(locations, "Location array must not be null");
int count = 0;
//配置文件有多个,加载多个配置文件
for (String location : locations) {
// 调用父类loadBeanDefinitions方法
count += loadBeanDefinitions(location);
}
return count;
}
进入 loadBeanDefinitions()的重载方法
类文件:org.springframework.context.support.
AbstractBeanDefinitionReader
/**
* TODO : 字符串类型的xml文件路径,转换成Resource对象类型。
*/
public int loadBeanDefinitions(String location, @Nullable Set<Resource> actualResources) throws BeanDefinitionStoreException {
// 获取上下文对象
ResourceLoader resourceLoader = getResourceLoader();
if (resourceLoader == null) {
throw new BeanDefinitionStoreException(
"Cannot load bean definitions from location [" + location + "]: no ResourceLoader available");
}
if (resourceLoader instanceof ResourcePatternResolver) {
// Resource pattern matching available.
try {
//把字符串类型的xml文件路径,形如:classpath*:user/**/*-context.xml,
// 转换成Resource对象类型,其实就是用流
//的方式加载配置文件,然后封装成Resource对象,不重要,可以不看
Resource[] resources = ((ResourcePatternResolver) resourceLoader).getResources(location);
//主要看这个方法 ** 重要程度 5
int count = loadBeanDefinitions(resources);
if (actualResources != null) {
Collections.addAll(actualResources, resources);
}
if (logger.isTraceEnabled()) {
logger.trace("Loaded " + count + " bean definitions from location pattern [" + location + "]");
}
return count;
}
catch (IOException ex) {
throw new BeanDefinitionStoreException(
"Could not resolve bean definition resource pattern [" + location + "]", ex);
}
}
else {
// Can only load single resources by absolute URL.
Resource resource = resourceLoader.getResource(location);
int count = loadBeanDefinitions(resource);
if (actualResources != null) {
actualResources.add(resource);
}
if (logger.isTraceEnabled()) {
logger.trace("Loaded " + count + " bean definitions from location [" + location + "]");
}
return count;
}
}
进入 loadBeanDefinitions()的重载方法
类文件:org.springframework.context.support.
AbstractBeanDefinitionReader
/**
* TODO : 得到转换成Resource对象类型个数
*/
public int loadBeanDefinitions(Resource... resources) throws BeanDefinitionStoreException {
Assert.notNull(resources, "Resource array must not be null");
int count = 0;
for (Resource resource : resources) {
//模板设计模式,调用到子类中的方法
count += loadBeanDefinitions(resource);
}
return count;
}
进入 loadBeanDefinitions()方法
类文件:org.springframework.beans.factory.xml.
XmlBeanDefinitionReader
/**
* TODO : 获取Resource对象中的xml文件流对象,转换成InputSource对象
* InputSource是jdk中的sax xml文件解析对象
*/
public int loadBeanDefinitions(EncodedResource encodedResource) throws BeanDefinitionStoreException {
Assert.notNull(encodedResource, "EncodedResource must not be null");
if (logger.isTraceEnabled()) {
logger.trace("Loading XML bean definitions from " + encodedResource);
}
Set<EncodedResource> currentResources = this.resourcesCurrentlyBeingLoaded.get();
if (currentResources == null) {
currentResources = new HashSet<>(4);
this.resourcesCurrentlyBeingLoaded.set(currentResources);
}
if (!currentResources.add(encodedResource)) {
throw new BeanDefinitionStoreException(
"Detected cyclic loading of " + encodedResource + " - check your import definitions!");
}
try {
//获取Resource对象中的xml文件流对象
InputStream inputStream = encodedResource.getResource().getInputStream();
try {
// 把文件流对象包装成 InputSource
// 注:InputSource是jdk包org.xml.sax中负责XML文档解析
InputSource inputSource = new InputSource(inputStream);
if (encodedResource.getEncoding() != null) {
inputSource.setEncoding(encodedResource.getEncoding());
}
//主要看这个方法 重要程度 5
return doLoadBeanDefinitions(inputSource, encodedResource.getResource());
}
finally {
inputStream.close();
}
}
catch (IOException ex) {
throw new BeanDefinitionStoreException(
"IOException parsing XML document from " + encodedResource.getResource(), ex);
}
finally {
currentResources.remove(encodedResource);
if (currentResources.isEmpty()) {
this.resourcesCurrentlyBeingLoaded.remove();
}
}
}
# │ ├─ doLoadBeanDefinitions()
进入
doLoadBeanDefinitions()
方法类文件:org.springframework.beans.factory.xml.
XmlBeanDefinitionReader
/**
* TODO : 最后封装成 BeanDefinition 对象
*/
protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource)
throws BeanDefinitionStoreException {
try {
//把inputSource 封装成Document文件对象,这是jdk的API
Document doc = doLoadDocument(inputSource, resource);
//主要看这个方法,根据解析出来的document对象,拿到里面的标签元素封装成BeanDefinition
int count = registerBeanDefinitions(doc, resource);
if (logger.isDebugEnabled()) {
logger.debug("Loaded " + count + " bean definitions from " + resource);
}
return count;
}
catch (BeanDefinitionStoreException ex) {
throw ex;
}
catch (SAXParseException ex) {
throw new XmlBeanDefinitionStoreException(resource.getDescription(),
"Line " + ex.getLineNumber() + " in XML document from " + resource + " is invalid", ex);
}
catch (SAXException ex) {
throw new XmlBeanDefinitionStoreException(resource.getDescription(),
"XML document from " + resource + " is invalid", ex);
}
catch (ParserConfigurationException ex) {
throw new BeanDefinitionStoreException(resource.getDescription(),
"Parser configuration exception parsing XML from " + resource, ex);
}
catch (IOException ex) {
throw new BeanDefinitionStoreException(resource.getDescription(),
"IOException parsing XML document from " + resource, ex);
}
catch (Throwable ex) {
throw new BeanDefinitionStoreException(resource.getDescription(),
"Unexpected exception parsing XML document from " + resource, ex);
}
}
# │ ├─ registerBeanDefinitions()
进入
registerBeanDefinitions()
方法类文件:org.springframework.beans.factory.xml.
XmlBeanDefinitionReader
/**
* TODO : 注册 BeanDefinition 对象
*/
public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException {
// 委托模式,BeanDefinitionDocumentReader委托这个类进行document的解析
BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader();
int countBefore = getRegistry().getBeanDefinitionCount();
// 主要看这个方法,createReaderContext(resource) XmlReaderContext上下文,
// 封装了XmlBeanDefinitionReader对象
documentReader.registerBeanDefinitions(doc, createReaderContext(resource));
return getRegistry().getBeanDefinitionCount() - countBefore;
}
知识点
- 类 名:
XmlReaderContext
- 所在包: org.springframework.beans.factory.xml
XmlReaderContext
可以理解为XML解析过程中的上下文,特点:
- 持有了
XmlBeanDefinitionReader reader
对象的引用。 - 将解析出来的
BeanDefinition
对象缓存到BeanDefinitionRegistry
。
# │ ├─ registerBeanDefinitions()
进入
registerBeanDefinitions()
方法类文件:org.springframework.beans.factory.xml.
DefaultBeanDefinitionDocumentReader
/**
* TODO : 过渡,实际处理在doRegisterBeanDefinitions
*/
public void registerBeanDefinitions(Document doc, XmlReaderContext readerContext) {
this.readerContext = readerContext;
// 主要看这个方法,把root节点传进去
doRegisterBeanDefinitions(doc.getDocumentElement());
}
# │ ├─ doRegisterBeanDefinitions()
进入
doRegisterBeanDefinitions()
方法类文件:org.springframework.beans.factory.xml.
DefaultBeanDefinitionDocumentReader
/**
* TODO : 创建BeanDefinitionParserDelegate委托对象,交给parseBeanDefinitions处理
*/
protected void doRegisterBeanDefinitions(Element root) {
BeanDefinitionParserDelegate parent = this.delegate;
this.delegate = createDelegate(getReaderContext(), root, parent);
if (this.delegate.isDefaultNamespace(root)) {
String profileSpec = root.getAttribute(PROFILE_ATTRIBUTE);
if (StringUtils.hasText(profileSpec)) {
String[] specifiedProfiles = StringUtils.tokenizeToStringArray(
profileSpec, BeanDefinitionParserDelegate.MULTI_VALUE_ATTRIBUTE_DELIMITERS);
if (!getReaderContext().getEnvironment().acceptsProfiles(specifiedProfiles)) {
if (logger.isDebugEnabled()) {
logger.debug("Skipped XML bean definition file due to specified profiles [" + profileSpec +
"] not matching: " + getReaderContext().getResource());
}
return;
}
}
}
// 冗余设计,模板方法
preProcessXml(root);
//主要看这个方法,标签具体解析过程
parseBeanDefinitions(root, this.delegate);
postProcessXml(root);
this.delegate = parent;
}
# │ ├─ parseBeanDefinitions()
进入
parseBeanDefinitions()
方法类文件:org.springframework.beans.factory.xml.
DefaultBeanDefinitionDocumentReader
/**
* TODO :XML中标签的具体解析过程
*/
protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) {
// 获取根节点
if (delegate.isDefaultNamespace(root)) {
// 获取根节点里的所有子节点
NodeList nl = root.getChildNodes();
// 循环遍历所有子节点,对整个xml文件进行解析
for (int i = 0; i < nl.getLength(); i++) {
Node node = nl.item(i);
if (node instanceof Element) {
Element ele = (Element) node;
if (delegate.isDefaultNamespace(ele)) {
//默认标签解析
parseDefaultElement(ele, delegate);
}
else {
//自定义标签解析,通过委托类BeanDefinitionParserDelegate解析
delegate.parseCustomElement(ele);
}
}
}
}
else {
delegate.parseCustomElement(root);
}
}
# │ │ ├─ parseDefaultElement()
进入
parseDefaultElement()
方法,默认标签解析类文件:org.springframework.beans.factory.xml.
DefaultBeanDefinitionDocumentReader
/**
* TODO : 默认标签的解析
*/
private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {
// import标签解析 重要程度 1 ,可看可不看
if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) {
importBeanDefinitionResource(ele);
}
// alias标签解析 别名标签 重要程度 1 ,可看可不看
else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) {
processAliasRegistration(ele);
}
// bean标签,重要程度 5,必须看
else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) {
processBeanDefinition(ele, delegate);
}
else if (delegate.nodeNameEquals(ele, NESTED_BEANS_ELEMENT)) {
// recurse
doRegisterBeanDefinitions(ele);
}
}
# │ │ │ ├─ processBeanDefinition()
进入
processBeanDefinition()
方法类文件:org.springframework.beans.factory.xml.
DefaultBeanDefinitionDocumentReader
/**
* TODO : 封装BeanDefinition的过程
*/
protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {
// 重点看这个方法,重要程度 5 ,解析document,封装成BeanDefinition
BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);
if (bdHolder != null) {
// 该方法功能不重要,设计模式重点看一下,装饰者设计模式,加上SPI设计思想
bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder);
try {
// 完成document到BeanDefinition对象转换后,对BeanDefinition对象进行缓存注册
BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry());
}
catch (BeanDefinitionStoreException ex) {
getReaderContext().error("Failed to register bean definition with name '" +
bdHolder.getBeanName() + "'", ele, ex);
}
// Send registration event.
getReaderContext().fireComponentRegistered(new BeanComponentDefinition(bdHolder));
}
}
知识点
decorateBeanDefinitionIfRequired()
方法 以装饰器模式来处理 BeanDefinitionHolder
,有以下两种:
- 根据bean标签属性,装饰
BeanDefinitionHolder
。 - 根据bean标签子元素,装饰
BeanDefinitionHolder
。
# │ │ │ ├─ parseBeanDefinition..()
进入
parseBeanDefinitionElement()
方法类文件:org.springframework.beans.factory.xml.
BeanDefinitionParserDelegate
/**
* TODO : 解析 Element 并返回 BeanDefinitionHolder 持有者
*/
public BeanDefinitionHolder parseBeanDefinitionElement(Element ele, @Nullable BeanDefinition containingBean) {
String id = ele.getAttribute(ID_ATTRIBUTE);
String nameAttr = ele.getAttribute(NAME_ATTRIBUTE);
List<String> aliases = new ArrayList<>();
if (StringUtils.hasLength(nameAttr)) {
String[] nameArr = StringUtils.tokenizeToStringArray(nameAttr, MULTI_VALUE_ATTRIBUTE_DELIMITERS);
aliases.addAll(Arrays.asList(nameArr));
}
String beanName = id;
if (!StringUtils.hasText(beanName) && !aliases.isEmpty()) {
beanName = aliases.remove(0);
if (logger.isTraceEnabled()) {
logger.trace("No XML 'id' specified - using '" + beanName +
"' as bean name and " + aliases + " as aliases");
}
}
// 检查 beanName 是否重复
if (containingBean == null) {
checkNameUniqueness(beanName, aliases, ele);
}
// 重点,解析BeanDefinitionElement
AbstractBeanDefinition beanDefinition = parseBeanDefinitionElement(ele, beanName, containingBean);
// 此处省略没用的代码
......
String[] aliasesArray = StringUtils.toStringArray(aliases);
return new BeanDefinitionHolder(beanDefinition, beanName, aliasesArray);
}
知识点
返回的BeanDefinitionHolder
为后续BeanDefinition
注册做准备,BeanDefinitionReaderUtils
类的registerBeanDefinition()
方法需要BeanDefinitionHolder
对象作为入参进行注册。在BeanDefinitionHolder
对象中持有beanDefinition
和beanName
两个重要属性。
- private final BeanDefinition
beanDefinition
; - private final String
beanName
; - private final String[]
aliases
;
aliases
作用:通过aliases
找到beanName
,根据beanName
拿到beanDefinition
对象。
进入
parseBeanDefinitionElement()
方法类文件:org.springframework.beans.factory.xml.
DefaultBeanDefinitionDocumentReader
/**
* TODO : 解析BeanDefinitionElement
*/
public AbstractBeanDefinition parseBeanDefinitionElement(
Element ele, String beanName, @Nullable BeanDefinition containingBean) {
this.parseState.push(new BeanEntry(beanName));
String className = null;
if (ele.hasAttribute(CLASS_ATTRIBUTE)) {
className = ele.getAttribute(CLASS_ATTRIBUTE).trim();
}
String parent = null;
if (ele.hasAttribute(PARENT_ATTRIBUTE)) {
parent = ele.getAttribute(PARENT_ATTRIBUTE);
}
try {
// 创建GenericBeanDefinition对象
AbstractBeanDefinition bd = createBeanDefinition(className, parent);
// 解析bean标签的属性,并把解析出来的属性设置到BeanDefinition对象中
parseBeanDefinitionAttributes(ele, beanName, containingBean, bd);
bd.setDescription(DomUtils.getChildElementValueByTagName(ele, DESCRIPTION_ELEMENT));
// 解析bean中的meta标签
parseMetaElements(ele, bd);
// 解析bean中的lookup-method标签 重要程度:2,可看可不看
parseLookupOverrideSubElements(ele, bd.getMethodOverrides());
// 解析bean中的replaced-method标签 重要程度:2,可看可不看
parseReplacedMethodSubElements(ele, bd.getMethodOverrides());
// 解析bean中的constructor-arg标签 重要程度:2,可看可不看
parseConstructorArgElements(ele, bd);
// 解析bean中的property标签 重要程度:2,可看可不看
parsePropertyElements(ele, bd);
// 可以不看,用不到
parseQualifierElements(ele, bd);
bd.setResource(this.readerContext.getResource());
bd.setSource(extractSource(ele));
return bd;
}
catch (ClassNotFoundException ex) {
error("Bean class [" + className + "] not found", ele, ex);
}
catch (NoClassDefFoundError err) {
error("Class that bean class [" + className + "] depends on not found", ele, err);
}
catch (Throwable ex) {
error("Unexpected failure during bean definition parsing", ele, ex);
}
finally {
this.parseState.pop();
}
return null;
}
知识点
<bean>
标签 解析完成,会统一放到BeanDefinition
中。<lookup-method>
、<replaced-method>
、<property>
这种子标签会放到MutablePropertyValues
类中。<constructor-arg>
子标签会放到ConstructorArgumentValues
类中。
# │ │ │ ├─ parseBeanDefinition..()
进入
parseBeanDefinitionAttributes()
方法,最终的BeanDefinition
属性在这里统一解析。
BeanDefinitionParserDelegate
委托类包含了所有bean 标签元素的属性常量。类文件:org.springframework.beans.factory.xml.
BeanDefinitionParserDelegate
public AbstractBeanDefinition parseBeanDefinitionAttributes(Element ele, String beanName,
@Nullable BeanDefinition containingBean, AbstractBeanDefinition bd) {
if (ele.hasAttribute(SINGLETON_ATTRIBUTE)) {
error("Old 1.x 'singleton' attribute in use - upgrade to 'scope' declaration", ele);
}
else if (ele.hasAttribute(SCOPE_ATTRIBUTE)) {
bd.setScope(ele.getAttribute(SCOPE_ATTRIBUTE));
}
else if (containingBean != null) {
// Take default from containing bean in case of an inner bean definition.
bd.setScope(containingBean.getScope());
}
if (ele.hasAttribute(ABSTRACT_ATTRIBUTE)) {
bd.setAbstract(TRUE_VALUE.equals(ele.getAttribute(ABSTRACT_ATTRIBUTE)));
}
String lazyInit = ele.getAttribute(LAZY_INIT_ATTRIBUTE);
if (DEFAULT_VALUE.equals(lazyInit)) {
lazyInit = this.defaults.getLazyInit();
}
bd.setLazyInit(TRUE_VALUE.equals(lazyInit));
String autowire = ele.getAttribute(AUTOWIRE_ATTRIBUTE);
bd.setAutowireMode(getAutowireMode(autowire));
if (ele.hasAttribute(DEPENDS_ON_ATTRIBUTE)) {
String dependsOn = ele.getAttribute(DEPENDS_ON_ATTRIBUTE);
bd.setDependsOn(StringUtils.tokenizeToStringArray(dependsOn, MULTI_VALUE_ATTRIBUTE_DELIMITERS));
}
//这个属性有代码案例演示,请参看案例
String autowireCandidate = ele.getAttribute(AUTOWIRE_CANDIDATE_ATTRIBUTE);
if ("".equals(autowireCandidate) || DEFAULT_VALUE.equals(autowireCandidate)) {
String candidatePattern = this.defaults.getAutowireCandidates();
if (candidatePattern != null) {
String[] patterns = StringUtils.commaDelimitedListToStringArray(candidatePattern);
bd.setAutowireCandidate(PatternMatchUtils.simpleMatch(patterns, beanName));
}
}
else {
bd.setAutowireCandidate(TRUE_VALUE.equals(autowireCandidate));
}
//这个属性有代码案例演示,请参看案例
if (ele.hasAttribute(PRIMARY_ATTRIBUTE)) {
bd.setPrimary(TRUE_VALUE.equals(ele.getAttribute(PRIMARY_ATTRIBUTE)));
}
//这个属性有代码案例演示,请参看案例
if (ele.hasAttribute(INIT_METHOD_ATTRIBUTE)) {
String initMethodName = ele.getAttribute(INIT_METHOD_ATTRIBUTE);
bd.setInitMethodName(initMethodName);
}
else if (this.defaults.getInitMethod() != null) {
bd.setInitMethodName(this.defaults.getInitMethod());
bd.setEnforceInitMethod(false);
}
//这个属性有代码案例演示,请参看案例
if (ele.hasAttribute(DESTROY_METHOD_ATTRIBUTE)) {
String destroyMethodName = ele.getAttribute(DESTROY_METHOD_ATTRIBUTE);
bd.setDestroyMethodName(destroyMethodName);
}
else if (this.defaults.getDestroyMethod() != null) {
bd.setDestroyMethodName(this.defaults.getDestroyMethod());
bd.setEnforceDestroyMethod(false);
}
//这个属性有代码案例演示,请参看案例
if (ele.hasAttribute(FACTORY_METHOD_ATTRIBUTE)) {
bd.setFactoryMethodName(ele.getAttribute(FACTORY_METHOD_ATTRIBUTE));
}
//这个属性有代码案例演示,请参看案例
if (ele.hasAttribute(FACTORY_BEAN_ATTRIBUTE)) {
bd.setFactoryBeanName(ele.getAttribute(FACTORY_BEAN_ATTRIBUTE));
}
return bd;
}
# │ │ │ └─ registerBeanDefinition()
返回到
DefaultBeanDefinitionDocumentReader
的processBeanDefinition()
方法继续往下走,第一步已经对BeanDefinition
属性解析完成,返回BeanDefinitionHolder
对象,接下来要注册registerBeanDefinition
。进入
registerBeanDefinition()
方法类文件:org.springframework.beans.factory.support.
BeanDefinitionReaderUtils
public static void registerBeanDefinition(
BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry)
throws BeanDefinitionStoreException {
String beanName = definitionHolder.getBeanName();
// 完成BeanDefinition的注册,重点看,重要程度 5
registry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition());
// 建立别名和 id的映射,这样就可以根据别名获取到id
String[] aliases = definitionHolder.getAliases();
if (aliases != null) {
for (String alias : aliases) {
registry.registerAlias(beanName, alias);
}
}
}
进入
registerBeanDefinition()
方法,最终完成默认的注册。类文件:org.springframework.beans.factory.support.
DefaultListableBeanFactory
public void registerBeanDefinition(String beanName, BeanDefinition beanDefinition)
throws BeanDefinitionStoreException {
Assert.hasText(beanName, "Bean name must not be empty");
Assert.notNull(beanDefinition, "BeanDefinition must not be null");
if (beanDefinition instanceof AbstractBeanDefinition) {
try {
((AbstractBeanDefinition) beanDefinition).validate();
}
catch (BeanDefinitionValidationException ex) {
throw new BeanDefinitionStoreException(beanDefinition.getResourceDescription(), beanName,
"Validation of bean definition failed", ex);
}
}
// 先判断 BeanDefinition 是否已经注册
BeanDefinition existingDefinition = this.beanDefinitionMap.get(beanName);
if (existingDefinition != null) {
if (!isAllowBeanDefinitionOverriding()) {
throw new BeanDefinitionOverrideException(beanName, beanDefinition, existingDefinition);
}
// ...... 省略 ......
else {
// 把 beanDefinition 缓存到map中
this.beanDefinitionMap.put(beanName, beanDefinition);
// 把 beanName 放到 beanDefinitionNames list中,bean实例化的时候需要用到
this.beanDefinitionNames.add(beanName);
this.manualSingletonNames.remove(beanName);
}
this.frozenBeanDefinitionNames = null;
}
if (existingDefinition != null || containsSingleton(beanName)) {
resetBeanDefinition(beanName);
}
}
知识点
DefaultListableBeanFactory
类的registerBeanDefinition
方法,最终会把bean名称和beanDefinition
放到
Map<String, BeanDefinition> beanDefinitionMap = new ConcurrentHashMap<>(256)
的
容器中,并且把bean名称放到List<String> beanDefinitionNames = new ArrayList<>(256)
的 list容器中缓存起来。
# │ │ ├─ parseCustomElement()
至此,默认标签的解析过程全部完成。
返回到
DefaultBeanDefinitionDocumentReader
的parseBeanDefinitions
方法进入
parseCustomElement()
方法,自定义标签解析类文件:org.springframework.beans.factory.xml.
BeanDefinitionParserDelegate
/**
* TODO : 自定义标签交给BeanDefinitionParserDelegate 委托类来解析
*/
public BeanDefinition parseCustomElement(Element ele, @Nullable BeanDefinition containingBd) {
// 获取命名空间的URI
String namespaceUri = getNamespaceURI(ele);
if (namespaceUri == null) {
return null;
}
// SPI设计,获取/META-INF/spring.handers中URI对应的Hander处理类
NamespaceHandler handler = this.readerContext.getNamespaceHandlerResolver().resolve(namespaceUri);
if (handler == null) {
error("Unable to locate Spring NamespaceHandler for XML schema namespace [" + namespaceUri + "]", ele);
return null;
}
// 执行 实现类NamespaceHandlerSupport 中的parse 方法
return handler.parse(ele, new ParserContext(this.readerContext, this, containingBd));
}
知识点
getNamespaceHandlerResolver().resolve()
方法 ,实际由DefaultNamespaceHandlerResolver.resolve()
方法实现,DefaultNamespaceHandlerResolver
类实现了NamespaceHandlerResolver
接口。具体解析内容如下:
- 获取spring中所有jar包里面的
META-INF/spring.handlers
文件,并且建立映射关系。 - 根据
namespaceUri
获取到这个命名空间的处理类。 - 调用处理类的
init()
方法,在init()
方法中完成标签元素解析类的注册。
# │ │ │ ├─ parse()
进入
parse()
方法类文件:org.springframework.beans.factory.xml.
NamespaceHandlerSupport
/**
* TODO : 委托BeanDefinitionParser类解析元素
*/
public BeanDefinition parse(Element element, ParserContext parserContext) {
// 获取自定义组件名 对应的解析方法
BeanDefinitionParser parser = findParserForElement(element, parserContext);
// 调用ComponentScanBeanDefinitionParser实现类中的 parse方法
return (parser != null ? parser.parse(element, parserContext) : null);
}
# │ │ │ ├─ findParserForElement()
进入
findParserForElement()
方法类文件:org.springframework.beans.factory.xml.
NamespaceHandlerSupport
/**
* TODO : 从map中根据组件名称获取绑定的解析方法
*/
private BeanDefinitionParser findParserForElement(Element element, ParserContext parserContext) {
// 获取组件名称
String localName = parserContext.getDelegate().getLocalName(element);
// Map<String, BeanDefinitionParser> parsers = new HashMap<>()
BeanDefinitionParser parser = this.parsers.get(localName);
if (parser == null) {
parserContext.getReaderContext().fatal(
"Cannot locate BeanDefinitionParser for element [" + localName + "]", element);
}
return parser;
}
知识点
此处this.parsers.get()
之所以有值,是因为在/META-INF/spring.handers
中URI对应的Hander
处理类初始化的时候
通过init()
方法中 执行registerBeanDefinitionParser()
,来调用this.parsers.set('标签元素','解析类')
设置的。
# │ │ │ ├─ parse()
findParserForElement()
方法解析完,返回一个对应标签元素的解析类进入
parse()
方法类文件:org.springframework.context.annotation.
ComponentScanBeanDefinitionParser
/** TODO: 核心解析
* 1、扫描路径.class后缀的文件
* 2、要判断类上是否有注解
* 3、GenericBeanDefinition genericBeanDefinition = new GenericBeanDefinition();
* genericBeanDefinition.setBeanClass(BeanClass.class);
* 4、完成beanDefinition注册
* */
public BeanDefinition parse(Element element, ParserContext parserContext) {
//获取basePackage属性
String basePackage = element.getAttribute(BASE_PACKAGE_ATTRIBUTE);
basePackage = parserContext.getReaderContext().getEnvironment().resolvePlaceholders(basePackage);
//可以用逗号分开
String[] basePackages = StringUtils.tokenizeToStringArray(basePackage,
ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS);
//创建注解扫描器
// Actually scan for bean definitions and register them.
ClassPathBeanDefinitionScanner scanner = configureScanner(parserContext, element);
//扫描并把扫描的类封装成beanDefinition对象 核心方法,重要程度 5
Set<BeanDefinitionHolder> beanDefinitions = scanner.doScan(basePackages);
registerComponents(parserContext.getReaderContext(), beanDefinitions, element);
return null;
}
# │ │ │ ├─ configureScanner()
进入
configureScanner()
方法,看看如何创建注解扫描器的类文件:org.springframework.context.annotation.
ComponentScanBeanDefinitionParser
protected ClassPathBeanDefinitionScanner configureScanner(ParserContext parserContext, Element element) {
//使用默认的过滤器
boolean useDefaultFilters = true;
//@Service @Component 默认filter
if (element.hasAttribute(USE_DEFAULT_FILTERS_ATTRIBUTE)) {
useDefaultFilters = Boolean.valueOf(element.getAttribute(USE_DEFAULT_FILTERS_ATTRIBUTE));
}
//创建注解的扫描器,主要看这个方法
ClassPathBeanDefinitionScanner scanner = createScanner(parserContext.getReaderContext(), useDefaultFilters);
scanner.setBeanDefinitionDefaults(parserContext.getDelegate().getBeanDefinitionDefaults());
scanner.setAutowireCandidatePatterns(parserContext.getDelegate().getAutowireCandidatePatterns());
if (element.hasAttribute(RESOURCE_PATTERN_ATTRIBUTE)) {
scanner.setResourcePattern(element.getAttribute(RESOURCE_PATTERN_ATTRIBUTE));
}
try {
// 解析子标签,不用看
parseBeanNameGenerator(element, scanner);
}
catch (Exception ex) {
parserContext.getReaderContext().error(ex.getMessage(), parserContext.extractSource(element), ex.getCause());
}
try {
// 解析子标签,不用看
parseScope(element, scanner);
}
catch (Exception ex) {
parserContext.getReaderContext().error(ex.getMessage(), parserContext.extractSource(element), ex.getCause());
}
// 会扫描含有"include-filter"和"exclude-filter"属性进行解析
parseTypeFilters(element, scanner, parserContext);
return scanner;
}
# │ │ │ ├─ createScanner()
进入
createScanner()
方法,类文件:org.springframework.context.annotation.
ComponentScanBeanDefinitionParser
protected ClassPathBeanDefinitionScanner createScanner(XmlReaderContext readerContext, boolean useDefaultFilters) {
return new ClassPathBeanDefinitionScanner(readerContext.getRegistry(), useDefaultFilters,
readerContext.getEnvironment(), readerContext.getResourceLoader());
}
# │ │ │ ├─ ClassPathBeanDefinition..()
进入
ClassPathBeanDefinitionScanner()
方法,类文件:org.springframework.context.annotation.
ClassPathBeanDefinitionScanner
public ClassPathBeanDefinitionScanner(BeanDefinitionRegistry registry, boolean useDefaultFilters,
Environment environment, @Nullable ResourceLoader resourceLoader) {
Assert.notNull(registry, "BeanDefinitionRegistry must not be null");
this.registry = registry;
//使用默认的过滤器
if (useDefaultFilters) {
//主要处理方法
registerDefaultFilters();
}
setEnvironment(environment);
setResourceLoader(resourceLoader);
}
# │ │ │ ├─ registerDefaultFilters()
进入
registerDefaultFilters()
方法,默认的类文件:org.springframework.context.annotation.
ClassPathScanningCandidateComponentProvider
/**
* TODO : 使用默认过滤规则 处理指定的注解类,然后注册
*/
protected void registerDefaultFilters() {
// 过滤器中添加需要扫描的注解类型
// 将注解添加到 AnnotationTypeFilter包装类
this.includeFilters.add(new AnnotationTypeFilter(Component.class));
// 确保类注解是 ClassPathScanningCandidateComponentProvider的类加载器
ClassLoader cl = ClassPathScanningCandidateComponentProvider.class.getClassLoader();
try {
this.includeFilters.add(new AnnotationTypeFilter(
((Class<? extends Annotation>) ClassUtils.forName("javax.annotation.ManagedBean", cl)), false));
logger.trace("JSR-250 'javax.annotation.ManagedBean' found and supported for component scanning");
}
catch (ClassNotFoundException ex) {
// JSR-250 1.1 API (as included in Java EE 6) not available - simply skip.
}
try {
this.includeFilters.add(new AnnotationTypeFilter(
((Class<? extends Annotation>) ClassUtils.forName("javax.inject.Named", cl)), false));
logger.trace("JSR-330 'javax.inject.Named' annotation found and supported for component scanning");
}
catch (ClassNotFoundException ex) {
// JSR-330 API not available - simply skip.
}
}
知识点
- 过滤器将会拦截
@Component
注解标注的类,包括被@Component
标注的@Service
,@Repository
,@Controller
以及Java EE 6的javax.annotation.ManagedBean
, JSR-330的javax.inject.Named
。 - 将拦截到的注解添加到
List<TypeFilter> includeFilters = new LinkedList<>()
容器中。 - 最后,根据匹配的
metadataReader
生成ScannedGenericBeanDefinition
。
@see
ClassPathScanningCandidateComponentProvider#scanCandidateComponents()
# │ │ │ ├─ doScan()
至此注解扫描器创建过程完毕,注解类填充到List中,
返回
parse()
方法,进入doScan()
方法,类文件:org.springframework.context.annotation.
ClassPathBeanDefinitionScanner
/**
* TODO : 根据base-package中的字符串扫描封装 BeanDefinition对象,执行BeanDefinition注册
*/
protected Set<BeanDefinitionHolder> doScan(String... basePackages) {
Assert.notEmpty(basePackages, "At least one base package must be specified");
Set<BeanDefinitionHolder> beanDefinitions = new LinkedHashSet<>();
for (String basePackage : basePackages) {
// 扫描到有注解的类并封装成 BeanDefinition对象
Set<BeanDefinition> candidates = findCandidateComponents(basePackage);
for (BeanDefinition candidate : candidates) {
ScopeMetadata scopeMetadata = this.scopeMetadataResolver.resolveScopeMetadata(candidate);
candidate.setScope(scopeMetadata.getScopeName());
String beanName = this.beanNameGenerator.generateBeanName(candidate, this.registry);
if (candidate instanceof AbstractBeanDefinition) {
postProcessBeanDefinition((AbstractBeanDefinition) candidate, beanName);
}
if (candidate instanceof AnnotatedBeanDefinition) {
// 支持了@Lazy @DependOn注解
AnnotationConfigUtils.processCommonDefinitionAnnotations((AnnotatedBeanDefinition) candidate);
}
if (checkCandidate(beanName, candidate)) {
BeanDefinitionHolder definitionHolder = new BeanDefinitionHolder(candidate, beanName);
//这里不看
definitionHolder =
AnnotationConfigUtils.applyScopedProxyMode(scopeMetadata, definitionHolder, this.registry);
beanDefinitions.add(definitionHolder);
// BeanDefinition注册
registerBeanDefinition(definitionHolder, this.registry);
}
}
}
return beanDefinitions;
}
# │ │ │ └─ registerBeanDefinition()
进入
registerBeanDefinition()
方法类文件:org.springframework.beans.factory.support.
BeanDefinitionReaderUtils
/**
* TODO : 向指定的bean工厂注册BeanDefinition
*/
public static void registerBeanDefinition(
BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry)
throws BeanDefinitionStoreException {
// Register bean definition under primary name.
String beanName = definitionHolder.getBeanName();
//完成BeanDefinition的注册,重点看,重要程度 5
registry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition());
//建立别名和 id的映射,这样就可以根据别名获取到id
// Register aliases for bean name, if any.
String[] aliases = definitionHolder.getAliases();
if (aliases != null) {
for (String alias : aliases) {
registry.registerAlias(beanName, alias);
}
}
}
进入
registerBeanDefinition()
方法,最终完成自定义标签的注册。类文件:org.springframework.beans.factory.support.
DefaultListableBeanFactory
public void registerBeanDefinition(String beanName, BeanDefinition beanDefinition)
throws BeanDefinitionStoreException {
Assert.hasText(beanName, "Bean name must not be empty");
Assert.notNull(beanDefinition, "BeanDefinition must not be null");
if (beanDefinition instanceof AbstractBeanDefinition) {
try {
((AbstractBeanDefinition) beanDefinition).validate();
}
catch (BeanDefinitionValidationException ex) {
throw new BeanDefinitionStoreException(beanDefinition.getResourceDescription(), beanName,
"Validation of bean definition failed", ex);
}
}
// 先判断 BeanDefinition是否已经注册
BeanDefinition existingDefinition = this.beanDefinitionMap.get(beanName);
if (existingDefinition != null) {
if (!isAllowBeanDefinitionOverriding()) {
throw new BeanDefinitionOverrideException(beanName, beanDefinition, existingDefinition);
}
// ...... 省略 ......
else {
// 把 beanDefinition 缓存到map中
this.beanDefinitionMap.put(beanName, beanDefinition);
//把 beanName放到 beanDefinitionNames list中,bean实例化的时候需要用到
this.beanDefinitionNames.add(beanName);
this.manualSingletonNames.remove(beanName);
}
this.frozenBeanDefinitionNames = null;
}
if (existingDefinition != null || containsSingleton(beanName)) {
resetBeanDefinition(beanName);
}
}
至此,自定义标签的解析过程全部完成。
总结
最终保存方式和默认标签的保存方式一致,都是放到对应的两个Map容器缓存起来。
同时,核心方法
refresh()
中的obtainFreshBeanFactory()
方法执行完成,解析出来的xml标签封装成BeanDefinition
对象,然后通过getBeanFactory()
方法 返回ConfigurableListableBeanFactory
对象,至此创建填充BeanFactory
的功能也全部完成。以上是核心方法
refresh()
中的obtainFreshBeanFactory()
方法中涉及的相关源码内容。